FoxitPDFSDKPython2.BorderInfo类 参考

继承自 FoxitPDFSDKPython2._object .

Public 成员函数
def	BorderInfo (width, style, intensity, dash_phase, dashes)
	构造函数，带参数。 更多...
def	BorderInfo ()
	默认构造函数。
def	BorderInfo (border_info)
	拷贝构造函数。 更多...
def	Set (width, style, intensity, dash_phase, dashes)
	设置边框信息。 更多...

静态 Public 属性
	cloud_intensity = _fsdk.BorderInfo_cloud_intensity
	云状效果的强度。 更多...
	dash_phase = _fsdk.BorderInfo_dash_phase
	虚线相位。 更多...
	e_Beveled = _fsdk.BorderInfo_e_Beveled
	边框样式：斜面。 更多...
	e_Cloudy = _fsdk.BorderInfo_e_Cloudy
	边框样式：云朵。 更多...
	e_Dashed = _fsdk.BorderInfo_e_Dashed
	边框样式：虚线。 更多...
	e_Inset = _fsdk.BorderInfo_e_Inset
	边框样式：内嵌。 更多...
	e_Solid = _fsdk.BorderInfo_e_Solid
	边框样式：实线
	e_UnderLine = _fsdk.BorderInfo_e_UnderLine
	边框样式：下划线。 更多...
	style = _fsdk.BorderInfo_style
	边框样式。请参考 FoxitPDFSDKPython2.BorderInfo.e_Solid 及相关值，应为这些值中的一个。
	width = _fsdk.BorderInfo_width
	边框宽度，以点为单位。 更多...

详细描述

此类表示注释边框信息。

构造及析构函数说明

BorderInfo() [1/2]

def FoxitPDFSDKPython2.BorderInfo.BorderInfo	(		width,
			style,
			intensity,
			dash_phase,
			dashes
	)

构造函数，带参数。

参数

[in]	width	边框宽度，以点为单位。这应该是一个非负值。 如果此值为0，则不绘制边框。
[in]	style	边框样式。请参考从FoxitPDFSDKPython2.BorderInfo.e_Solid 开始的值， 这应该是这些值中的一个。
[in]	intensity	云状效果的强度。仅当参数style为 FoxitPDFSDKPython2.BorderInfo.e_Cloudy 时才有用。有效值范围：0到2。 0表示没有云状边框效果。 如果值小于0，将与值0具有相同效果。 如果值大于2，将与值2具有相同效果。
[in]	dash_phase	虚线相位。仅在参数style为 FoxitPDFSDKPython2.BorderInfo.e_Dashed 时有用。
[in]	dashes	表示虚线模式的虚线数组。此数组中每个元素的值 不应为负数。仅在style为FoxitPDFSDKPython2.BorderInfo.e_Dashed 时有用。

BorderInfo() [2/2]

def FoxitPDFSDKPython2.BorderInfo.BorderInfo

(

border_info

)

拷贝构造函数。

参数

[in]

border_info

另一个边框信息对象。

成员函数说明

Set()

def FoxitPDFSDKPython2.BorderInfo.Set	(		width,
			style,
			intensity,
			dash_phase,
			dashes
	)

设置边框信息。

参数

[in]	width	边框宽度（单位：点）。应为非负值。为0时不绘制边框。
[in]	style	边框样式。请参考从FoxitPDFSDKPython2.BorderInfo.e_Solid 开始的值，这应该是这些值中的一个。
[in]	intensity	云状效果强度，仅当style为FoxitPDFSDKPython2.BorderInfo.e_Cloudy 时有效。有效范围0~2。 0表示无云状效果。小于0等同于0，大于2等同于2。
[in]	dash_phase	虚线起始相位，仅当style为FoxitPDFSDKPython2.BorderInfo.e_Dashed 时有效。
[in]	dashes	虚线数组，表示虚线模式。数组中每个元素都应为非负值，仅当style为FoxitPDFSDKPython2.BorderInfo.e_Dashed 时有效。

返回

无。

类成员变量说明

cloud_intensity

FoxitPDFSDKPython2.BorderInfo.cloud_intensity = _fsdk.BorderInfo_cloud_intensity

static

云状效果的强度。

仅对自由文本、正方形、圆形和多边形注释有用，当前对象的 style 为 FoxitPDFSDKPython2.BorderInfo.e_Cloudy 时。
建议值范围：0 到 2。0 表示无云状边框效果。
其他值的效果为：

• 如果值小于 0，将与值 0 具有相同效果。

• 如果值大于 2，将与值 2 具有相同效果。

dash_phase

FoxitPDFSDKPython2.BorderInfo.dash_phase = _fsdk.BorderInfo_dash_phase

static

虚线相位。

仅在当前对象的 style 为 FoxitPDFSDKPython2.BorderInfo.e_Dashed 时有用。

e_Beveled

FoxitPDFSDKPython2.BorderInfo.e_Beveled = _fsdk.BorderInfo_e_Beveled

static

边框样式：斜面。

目前，福昕PDF SDK不支持此边框样式的注释外观。 如果将此设置为任何注释，福昕PDF SDK内部会默认将边框样式更改为 FoxitPDFSDKPython2.BorderInfo.e_Solid 。

e_Cloudy

FoxitPDFSDKPython2.BorderInfo.e_Cloudy = _fsdk.BorderInfo_e_Cloudy

static

边框样式：云朵。

这仅对自由文本、正方形、圆形和多边形注释有用。 如果将此设置为其他类型的注释，福昕PDF SDK内部会默认将边框样式更改为 FoxitPDFSDKPython2.BorderInfo.e_Solid 。

e_Dashed

FoxitPDFSDKPython2.BorderInfo.e_Dashed = _fsdk.BorderInfo_e_Dashed

static

边框样式：虚线。

这仅对链接、自由文本、线条、正方形、圆形、多边形、折线和屏幕注释有用。 如果将此设置为其他类型的注释，福昕PDF SDK内部会默认将边框样式更改为 FoxitPDFSDKPython2.BorderInfo.e_Solid 。

e_Inset

FoxitPDFSDKPython2.BorderInfo.e_Inset = _fsdk.BorderInfo_e_Inset

static

边框样式：内嵌。

目前，福昕PDF SDK不支持此边框样式的注释外观。 如果将此设置为任何注释，福昕PDF SDK内部会默认将边框样式更改为 FoxitPDFSDKPython2.BorderInfo.e_Solid 。

e_UnderLine

FoxitPDFSDKPython2.BorderInfo.e_UnderLine = _fsdk.BorderInfo_e_UnderLine

static

边框样式：下划线。

这仅对链接注释有用。如果将此设置为其他类型的注释，福昕PDF SDK内部会 默认将边框样式更改为FoxitPDFSDKPython2.BorderInfo.e_Solid 。

width

FoxitPDFSDKPython2.BorderInfo.width = _fsdk.BorderInfo_width

static

边框宽度，以点为单位。

此值不应为负数。如果此值为 0，则不会绘制边框。